home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d6 / rokmar.arc / ASSETS.DOC < prev    next >
Text File  |  1988-11-16  |  24KB  |  509 lines

  1.        
  2.         Technical Information:
  3.        
  4.         Equipment needed: IBM-PC (128K) 
  5.                           Floppy or hard disk
  6.                           Color or Monocrome monitor
  7.                           Printer
  8.        
  9.         Configuration:    Printer Port (LST1:)
  10.                           (If  necessary to print to another  port,  use 
  11.                           the MODE command to redirect printer output.)
  12.        
  13.         Files contained on this disk:
  14.                        ASSETS.EXE   -  The main program to execute
  15.                        ASSETS.HLP   -  The help data file
  16.                        ASSETS.DOC   -  The usage manual
  17.                        ASSETS.DAT   -  The main data database file
  18.                        ASSETS.X01   -  The key index file
  19.                        ASSETS.X02   -  The type index file
  20.                        ASSETS.X03   -  The location index file
  21.                        ASSETS.X04   -  The user-defined field index file
  22.                        ASREPORT.EXE -  The report writer program
  23.                        ASINDEX.EXE  -  The reindexer program
  24.        
  25.        
  26.        
  27.                     
  28.                    ROKMAR HOME/OFFICE ASSETS INVENTORY SYSTEM
  29.        
  30.        
  31.        
  32.        
  33.        
  34.        
  35.        
  36.        
  37.        
  38.        
  39.        
  40.        
  41.        
  42.                                        INDEX
  43.        
  44.                          Copyright Notice ............ 1
  45.                          What Is It For? ............. 2
  46.                          Set Up ...................... 3
  47.                          Field Editing ............... 4
  48.                          Program Usage ............... 5
  49.                          How To Use It ............... 7
  50.                          Field Descriptions .......... 8
  51.                          Interfacing ................. 9
  52.                          Error Recovery .............. 11
  53.        
  54.        
  55.        
  56.                                 COPYRIGHT NOTICE                 Page  1
  57.        
  58.        This  software  product  is the copyrighted  property  of  RokMar 
  59.        Computer  Systems,  and  the usual  shareware  limited  agreement 
  60.        applies:
  61.        
  62.        1.  No  fee may be charged for the retail sale  of  this  product 
  63.        other than a reasonable copy and distribution charge.
  64.        
  65.        2.  This  product  may only be distributed in  its  original  and 
  66.        complete form, including documentation and copyright notice.
  67.        
  68.        3.  This product may not be distributed, whole or in any part  as 
  69.        a  section  or  part of any commercial  product  without  written 
  70.        permission of ROKMAR COMPUTER SYSTEMS. 
  71.        
  72.        
  73.                                    DISCLAIMER
  74.        
  75.        RokMar  Computer  Systems will not be liable for any  damages  or 
  76.        claims  related  in  any  way to the  use  of  this  product  and 
  77.        disclaims   all   warranties  or  implied   warranties   by   the 
  78.        distributor.
  79.        
  80.        Other  than these minor trivialities, feel free to copy and  give 
  81.        out  as  many  copies  of this product as  you  wish.   Place  an 
  82.        archived version on any BBS.
  83.        
  84.        Should  you receive any use from this program, please  contribute 
  85.        $10, or if you wish to receive an updated version of this program 
  86.        with  bug fixes and possible enhancements, and notices to  future 
  87.        updates, send $15 to:
  88.        
  89.                               Robert O Keith, Jr.
  90.                               29660 Dixon St.
  91.                               Hayward, Ca. 94544
  92.        
  93.        Anything you might send, $, suggestions, problems will be greatly 
  94.        appreciated and will prompt me to produce many more products  for 
  95.        the  home and office. The registration fee will also entitle  you 
  96.        to a list of other available products. Remember, you did not have 
  97.        to bother to program this for yourself...
  98.        
  99.        Have fun, and remember... Press F1 for Help!
  100.        
  101.        
  102.        
  103.                                  WHAT IS IT FOR?                 Page  2
  104.        
  105.        Now  that  I have my own Home/Office  Assets  Inventory  DataBase 
  106.        system, what do I do with it?  What good is it? 
  107.        
  108.            Most people may or may not think they have much money  laying 
  109.        around the house or office.  In any case, most will be  surprised 
  110.        at  how  much has been collected over the months and  years.   In 
  111.        most  cases,  much of this money sits  around  mostly  unnoticed. 
  112.        People  who have used this product have been shocked to find  out 
  113.        how  much money was tied up in household/office assets,  in  what 
  114.        areas   this  money  was  concentrated,  and  in  what  type   of 
  115.        merchandise  they  had.   In  case  of  fire,  theft,  etc.,  the 
  116.        insurance  company  wants  an  itemized list  of  each  piece  of 
  117.        merchandise, the model numbers, the serial numbers, the  location 
  118.        the  article was kept, the purchase/replacement cost,  etc.  This 
  119.        bit  of information can be difficult to piece together  with  any 
  120.        amount of accuracy, especially in the midst of emotional  strife. 
  121.        If  this information was gathered together in  advance  manually, 
  122.        what  a  maintenance chore this could be: new items  are  bought, 
  123.        sold, thrown away, lost, etc., every month.
  124.            This  information  is also useful for  management  decisions: 
  125.        adequate security, fire protection, adequate insurance  coverage, 
  126.        or  even  how  much money is invested  by  merchandise  type,  at 
  127.        certain  locations,  etc.     The  Home/Office  Assets  Inventory 
  128.        DataBase will retain this information on a dynamic medium,  where 
  129.        at  the press of a button the information can be  listed,  sorted 
  130.        and  summed  up by type, location, etc. This  product  will  also 
  131.        print a list, ready to mail off to the insurance company or store 
  132.        offsite at any time.
  133.        
  134.        The Home/Office Assets Inventory DataBase Contains:
  135.          -  Pull Down Menu System, very simple to use.
  136.          -  Pop  Up  windows  including help windows so that  you  don't                  
  137.             become lost inside the integrated programs.
  138.          -  Full Feature Search/Inquiry screens, to browse your data  by       
  139.             key words.
  140.          -  Index Reports for your own information, (where, how much, of            
  141.             what, etc.)
  142.          -  Full  Detailed  Reports for safe storage and to mail off  to         
  143.             the insurance companies.
  144.          -  Data  Entry Input form printable on your own printer at  any       
  145.             time.
  146.        
  147.        Can you use this?
  148.        
  149.        
  150.        
  151.                                     SET UP                       Page  3
  152.        
  153.        INSTALLING UP THIS SYSTEM ON YOUR COMPUTER.
  154.        
  155.        Make a copy of this disk for your own backup at once!
  156.        
  157.        An   installation  program  is  not  included;  they   are   more 
  158.        complicated than simply copying the files to your hard disk,  and 
  159.        most of them cause more trouble than help anyway.
  160.        
  161.        
  162.        Installation on any Floppy Disk Drive:
  163.            Simply  copy  the  original  disk and use  the  copy  as  the 
  164.        program/data disk. One disk and drive is all that is required for 
  165.        use.  These files may also be copied to a bootable floppy disk. 
  166.        
  167.        Hard Drive:
  168.            Create  a  directory  (\ASSETS,  \HOMEINV,  \OFFINVEN,  etc.), 
  169.        anything  you  wish and copy the contents of this disk  into  the 
  170.        directory.  Remember,  only  rookies copy  all  of  the  software 
  171.        including DOS to the root directory.
  172.        
  173.              Example: C>COPY A:*.* A:\ASSETS
  174.        
  175.        The  executable program file of this system is ASSETS.EXE, so  to 
  176.        run,  move  to  the drive and directory where  the  programs  are 
  177.        installed and type: 
  178.        
  179.              ASSETS
  180.        
  181.              Example:
  182.        
  183.              One floppy drive: A>ASSETS
  184.              Hard Disk:C>CD \ASSETS
  185.                        C>ASSETS
  186.        
  187.        
  188.        
  189.        The  pull  down menu will come up on your screen.   If  you  have 
  190.        never  used  this  type  of menu, Press F1  for  Help.  Press  F1 
  191.        anywhere inside this system, and a help screen will appear.
  192.        
  193.        
  194.        
  195.                                 FIELD EDITING                    Page  4
  196.        
  197.        Using the data entry fields.
  198.        
  199.             The  data entry screens and the inquiry screens have one  or 
  200.        many  entry  fields.   The data in each of these  fields  may  be 
  201.        edited  after  some value has been entered.  The  type  of  edits 
  202.        available  for  each field include, inserting  characters  inside 
  203.        data  already edited, deleting characters, etc.  This  scheme  is 
  204.        similar  to word processors, spread sheets, etc.  Following is  a 
  205.        detailed list of each function and the key to be used for each.
  206.        
  207.        Key    Function
  208.        ____   __________________________________________________________
  209.        
  210.        Ins    This  will  toggle into or out of  the  insert  mode.  The 
  211.               cursor  will  be a block character when inside the  insert
  212.               mode. When  inside the insert mode, any data above and  to
  213.               the right  of the  cursor will be moved over and the  data
  214.               typed will be  shoved inside, inserted.
  215.        
  216.        Del    The Delete Key: The character above  the  cursor  will  be 
  217.               deleted and the data to the right will be  moved  over  to  
  218.               fill the space created by the character deleted.
  219.        
  220.        BS     The Back-Space Key: The cursor will be moved to the  left;
  221.               any data above the cursor will be deleted; the data to the
  222.               right will be moved to the left.
  223.        
  224.        -->    The  right  arrow  key:  The  cursor  will  be  moved  one 
  225.               character to the right, no data will be affected.
  226.        
  227.        <--    The left arrow key: The cursor will be moved one character
  228.               to the left, no data will be affected.
  229.        
  230.        Up     The up arrow key: The cursor will jump up to the  previous
  231.               data entry field.
  232.        
  233.        Down   The down arrow key: The cursor will jump down to the  next
  234.               data entry field.
  235.        
  236.        Return The return/entry key: The cursor  will  jump  down  to the
  237.               next data entry field.
  238.        
  239.        Esc    The escape key: This will exit  the  mode  of  the program 
  240.               without doing any updates to the database.
  241.        
  242.        
  243.        
  244.                                   PROGRAM USAGE                  Page  5
  245.        
  246.        A Walk through of the system.
  247.        
  248.             This  section  will be listed in sections in  the  order  of 
  249.        initial  usage.  Any semi-experienced user can breeze  over  this 
  250.        section  quickly and not work through the exercises, but keep  in 
  251.        mind the overall program flow and the uses of each function. 
  252.        
  253.          1.  (RPTFORM) Print an input form.  This is the last option  on 
  254.        the menu. Once this is printed, you may print as many as you wish 
  255.        or  make photocopies of the printed version.  With  this  version 
  256.        you  can manually take inventory, listing the pertinent  data  on 
  257.        the sheets, then use the sheets as data entry forms to sit at the 
  258.        computer and enter the data.  The first field on the sheet is the 
  259.        key field. This can be any value you wish, but it must be unique. 
  260.        Numbering  the  items  is usually the simplest way  to  choose  a 
  261.        unique key, but the add function will accept any unique string of 
  262.        characters. 
  263.        
  264.          2. (ADD) Enter the data. This is the first option on the  menu. 
  265.        Simply  transcribe the data directly from the input  sheets  into 
  266.        the  add function.  Press F1 if any field is confusing, a pop  up 
  267.        help  window  will appear. A full description of  each  field  is 
  268.        described in a later chapter.
  269.        
  270.          3. (UPDATE) If you make any entry mistakes, use the third  menu 
  271.        option.   These   functions   will  allow   data   entry   record 
  272.        modifications  or to delete the entire record.  Again,  Press  F1 
  273.        for guidance. 
  274.        
  275.          4.  (INQUIRY) At any time, you may wish to search  through  the 
  276.        data  for  a  particular item, to do this,  use  the  forth  menu 
  277.        function.
  278.             This  is  the most complicated screen, but don't  worry,  it 
  279.        does  no  updates so you can not hurt anything  by  pressing  the 
  280.        wrong button.  The three inquiry screens work basically the  same 
  281.        but  work  against different keys, TYPE, LOCATION and  the  USER-
  282.        DEFINED  key.  Specific  key info is at the  upper  left  of  the 
  283.        screen.  A quick run through:
  284.             - Enter the screen via the menu.
  285.             - Enter the key value desired.
  286.             This  may be the whole key, the first few     characters  of 
  287.        this  key,  or  to  begin  at  the  beginning,  leave  the  field     
  288.        blank.  Then press F2 to begin the search.  
  289.             - Continue   to press F2 to search from the last  record  on 
  290.               the screen...
  291.             - Or, Enter a different search key value...
  292.             - Or, Press F7 to scroll backwards; F8 to scroll forward.
  293.             - The  up/down arrow  keys will move the  high-lighted  line 
  294.               upward or downward. 
  295.             - Press  the  F3 key, and the high-lighted  record  will  be 
  296.               shown in detail inside another window in the middle of the 
  297.               screen.
  298.        
  299.        
  300.                                  PROGRAM USAGE (cont.)           Page  6
  301.        
  302.          5.  (RPT  INDX) These reports are for your  use  as  management 
  303.        information.  Simply  selecting  the  menu  option  desired   and 
  304.        pressing  return will     cause the report to begin printing,  so 
  305.        have the printer on and ready. 
  306.        
  307.          6. (RPT FULL) These reports are detailed reports sorted by  the 
  308.        menu      option  chosen. They are for  your  permanent  off-site 
  309.        storage and to be sent to insurance agencies, etc. 
  310.        
  311.        
  312.        
  313.        
  314.                                  HOW TO USE IT                   Page  7
  315.        
  316.             Anyone  who  has been through a fire, burglary,  or  any  of 
  317.        numerous  disasters, and have had to try to list everything  they 
  318.        own,  how  much  the  items were worth,  and  prove  it,  (Serial 
  319.        numbers?)  all this in the midst of an emotionally  trying  time, 
  320.        wishing  they  had been better prepared.     Insurance  companies 
  321.        usually  request  an  updated listing of  inventories  every  six 
  322.        months. Pictures should also be included with this list.  An even 
  323.        better  solution is a video tape recording of the articles,  time 
  324.        and date stamped.  The entire room can be panned across  catching 
  325.        everything in the room.
  326.             Don't  forget articles left inside closets  or  behind/under 
  327.        furniture.
  328.             Anything  one  might forget to take a  snapshot  of  usually 
  329.        shows up in a video tape, somewhere in the background.   Remember 
  330.        to get a shot of the camera. Of course, pictures are not  enough, 
  331.        serial  numbers,  costs, etc. are still required.     You  should 
  332.        also keep your own version of this file, but include  photocopies 
  333.        of receipts, and store this off-site in a safe location. 
  334.        
  335.             How  many  think to keep backups of software  offsite?  This 
  336.        system will tell you how important that might be. 
  337.        
  338.        Hints/Reminders:
  339.         -  Include  items  often forgotten in  this  list:
  340.             Expensive Clothing Articles          Landscaping Purchases
  341.             Books                                Telephones
  342.             Computer Software                    Lighting Fixtures
  343.             Customized Curtains                  The Hot Water Heater
  344.             Kitchen Appliances and Utensils      Tap Water Filters
  345.             Children's Articles                  Outside Articles
  346.        
  347.         -   Search  through  the closets, garages, in  the  automobiles, 
  348.             off-site    storage,  cellars, etc., places  not  frequently 
  349.             visited. 
  350.         -   Items  that  may  be  lended to someone  else  at  the  time 
  351.             inventory is taken.
  352.         -   Include important papers which may become lost or destroyed.
  353.        
  354.        
  355.        
  356.                                  FIELD DESCRIPTIONS                 Page  8
  357.        
  358.        
  359.          Field              Description                   Size    Cobol Pic
  360.        -----------------    ---------------------------   ------  ---------
  361.         ASSET_KEY            A unique key                  5      X(5)
  362.        
  363.         DESC                 The Description of the        25     X(25)
  364.                               article of value.
  365.        
  366.         TYPE                 The Type code. A category     8      X(8)
  367.                               for the article, ie., tools,
  368.                               equipment, etc.
  369.        
  370.         LOCATION_STORED      The Location Code where the   8      X(85)
  371.                               article is stored, ie.,
  372.                               garage, offsite, xa-01-01, 
  373.                               etc.
  374.        
  375.         USER_DEFINED         A User-Defined code for any   8      X(8)
  376.                               special purpose requirement,
  377.                               ie., persons name, sub-
  378.                               breakdowns of Type or
  379.                               Location, anything you wish.
  380.        
  381.         DATE_PURCHASED       The date the article was      6      X(6)
  382.                               purchased.                         (MMDDYY)  
  383.        
  384.         PURCHASE_COST        The purchase cost or value    7      9(5)v99
  385.                               of the article.                  (characters)
  386.        
  387.         PURCHASED_FROM       Description of where the      25     X(25)
  388.                               article was purchased from.
  389.        
  390.         APPRAISAL            The appraisal value, if       9      9(5)V99
  391.                               applicable.                          
  392.        
  393.         MODEL_NUMBER         The article model number.     10     X(10)
  394.        
  395.         SERIAL_NUMBER        The article serial number.    20     X(20)
  396.        
  397.         COMMENT1             First line of Comments.       50     X(50)
  398.        
  399.         COMMENT2             Second line of Comments.      50     X(50)
  400.        
  401.        
  402.        
  403.                                   INTERFACING                    Page  9
  404.        
  405.            This  feature  is for the advanced computerist,  and  is  not 
  406.        required to use this package as it was intended.  If, though, you 
  407.        are interested or have a special requirement, such as including a 
  408.        portion  of  this  data  in a financial  statement,  or  using  a 
  409.        spreadsheet for more elaborate calculations on the data, or  even 
  410.        want  to  extract  the data maintained here and  upload  it  into 
  411.        another database, you will want to read this section completely. 
  412.        
  413.            This  database  application package contains  a  very  useful 
  414.        report  writer/data extractor.  This can be used to  create  your 
  415.        own reports, specify any subset of fields to extract, browse  the 
  416.        data very quickly, extract data into an ASCII file uploadable  to 
  417.        any word processor, spreadsheet, database package, report writer, 
  418.        etc.  This  feature does not work under the menu system,  so  you 
  419.        will  have  to  be at the operating system prompt  to  use  these 
  420.        commands.
  421.        
  422.            The command name is ASREPORT.
  423.        
  424.            The  following descriptions will use the A> prompt. Don't  be 
  425.        confused  if  you  are  using a  different  disk  drive  and  see 
  426.        something else. 
  427.        
  428.            For a demonstration, type:
  429.                A>ASREPORT ASSETS
  430.        
  431.            The  entire list of records will scroll across  your  screen. 
  432.        This is interesting if used as a browse of the data. Now try: 
  433.        
  434.                A>ASREPORT ASSETS ASSET_TYPE DESC
  435.        
  436.            Notice  that  only the data fields you selected, and  in  the 
  437.        order  you  selected  appear. Interesting?  The  format  of  this 
  438.        command is: 
  439.        
  440.                A>ASREPORT ASSETS [file-element1 file-element2 ...]
  441.        
  442.            The  file elements are those listed in the  previous  chapter 
  443.        and must be spelled exactly.  If the file elements are not  used, 
  444.        all  elements  will be extracted.  If listed on the  screen,  the 
  445.        right most elements will be truncated.  Now lets print something: 
  446.        
  447.           A>ASREPORT ASSETS TYPE DESC LOCATION_STORED PURCHASE_COST > PRN
  448.        
  449.            Another way to do this would be:
  450.        
  451.           A>ASREPORT ASSETS TYPE DESC LOCATION_STORED PURCHASE_COST > MYFILE
  452.           A>COPY MYFILE PRN
  453.        
  454.            The  first method extracts the data and redirects the I/O  to 
  455.        the  printing  device. The second method extracts  the  data  and 
  456.        redirects the I/O into a file of your own choosing. 
  457.        
  458.        
  459.                                   INTERFACING (cont.)            Page 10
  460.        
  461.             Why extract the data into another file?
  462.             This is one of the nicer features of this system.  This file 
  463.        can  be  imported  into  any  spreadsheet,  (Lotus  123,   etc.), 
  464.        database,  or word processing program.  The data may be  used  by 
  465.        the spreadsheet program to be reformatted, sorted in other  ways, 
  466.        or  used for more elaborate calculations.  The database  may  use 
  467.        this data to be uploaded into other databases or report the  data 
  468.        in other formats. The data may be included into a word  processor 
  469.        for  use  inside  a financial report, or for  any  other  special 
  470.        purpose. 
  471.        
  472.        
  473.        
  474.                                ERROR RECOVERY                    Page 11
  475.        
  476.             The  error  messages displayed in the error  window  at  the 
  477.        bottom,  or inside other windows at various locations  should  be 
  478.        obvious,  ie., RECORD NOT FOUND, etc. There is one killer:  INDEX 
  479.        CORRUPTED. 
  480.        
  481.             The index corrupted message means that the database has been 
  482.        corrupted,  and the whole system is hung up.  Nothing will  work.        
  483.        All is not lost.
  484.        
  485.             To recover from this, a special program was developed called 
  486.        ASINDEX.
  487.        
  488.             To recover, type:
  489.        
  490.             Floppy system:
  491.             A>ASINDEX ASSETS
  492.        
  493.             Hard Disk:
  494.             C>ASINDEX ASSETS
  495.        
  496.             A corrupted database happens when inside the system and  the 
  497.        power is lost, if there is a disk error, etc.  It is not a normal 
  498.        condition and should not happen frequently. 
  499.        
  500.        REMEMBER TO BACKUP YOUR DATA REGULARLY!!!
  501.        
  502.             The database routines used in this system will put the  disk 
  503.        drive  through its paces. Occasionally, a machine will  return  a 
  504.        "index  corrupted" message when using any of the functions  which 
  505.        access data.  This could mean that the disk drive is slightly out 
  506.        of  alignment,  even though most of other programs may  work.  If 
  507.        this  is the case, reindexing and running the system  on  another 
  508.        machine may be necessary.
  509.